/*
 ***********************************************************************************************************************
 *
 *  Copyright (c) 2017-2021 Advanced Micro Devices, Inc. All Rights Reserved.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 *
 **********************************************************************************************************************/

#include "core/hw/gfxip/cmdUploadRing.h"

namespace Pal
{
namespace Gfx6
{

class CmdUtil;
class Device;

// =====================================================================================================================
// Contains packet-specific knowledge needed to upload command streams.
class CmdUploadRing final : public Pal::CmdUploadRing
{
public:
    static Result CreateInternal(
        const CmdUploadRingCreateInfo& createInfo,
        Device*                        pDevice,
        Pal::CmdUploadRing**           ppCmdUploadRing);

private:
    CmdUploadRing(
        const CmdUploadRingCreateInfo& createInfo,
        Device*                        pDevice,
        uint32                         minPostambleBytes);

    virtual ~CmdUploadRing() {}

    virtual void UploadChainPostamble(
        const IGpuMemory& raftMemory,
        ICmdBuffer*       pCopyCmdBuffer,
        gpusize           postambleOffset,
        gpusize           postambleBytes,
        gpusize           chainDestAddr,
        gpusize           chainDestBytes,
        bool              isConstantEngine,
        bool              isPreemptionEnabled) override;

    const CmdUtil& m_cmdUtil;
};

} // Gfx6
} // Pal
